// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------
// Modification history:
// feature: Unified Transport Abstraction Layer Unified Transport Abstraction Layer
// ------------------------------------------------------------------

#ifndef INCLUDE_EDDS_RTPS_TRANSPORT_TRANSPORTRECEIVERINTERFACE_H_
#define INCLUDE_EDDS_RTPS_TRANSPORT_TRANSPORTRECEIVERINTERFACE_H_

#include <ertps/utils/LocatorAlias.h>

namespace vbs {
namespace transport {

/**
 * Interface against which to implement a data receiver, decoupled from transport internals.
 * @ingroup TRANSPORT_MODULE
 * */
class TransportReceiverInterface {
 public:
    //! Destructor
    virtual ~TransportReceiverInterface() = default;

    /**
    * Method to be called by the transport when receiving data.
    * @param data Pointer to the received data.
    * @param size Number of bytes received.
    * @param local_locator Locator identifying the local endpoint.
    * @param remote_locator Locator identifying the remote endpoint.
    */
    virtual void OnDataReceived(const unsigned char* data, const uint32_t size, const Locator& local_locator,
                                const Locator& remote_locator) = 0;

    /**
    * Method to be called when an existing connection is disconnected.
    * @param local_locator Locator identifying the local endpoint.
    * @param remote_locator Locator identifying the remote endpoint.
    */
    virtual void OnDisconnected(const Locator& local_locator, const Locator& remote_locator) {
        (void)local_locator;
        (void)remote_locator;
    }
    /**
    * Method to be called when a new connection is accepted.
    * @param local_locator Locator identifying the local endpoint.
    * @param remote_locator Locator identifying the remote endpoint.
    */
    virtual void OnNewAccepted(const Locator& local_locator, const Locator& remote_locator) {
        (void)local_locator;
        (void)remote_locator;
    }
};

}  // namespace transport
}  // namespace vbs

#endif  // INCLUDE_EDDS_RTPS_TRANSPORT_TRANSPORTRECEIVERINTERFACE_H_
